home *** CD-ROM | disk | FTP | other *** search
/ Practical Internet 2001 August / Practical Internet August 2001.iso / Software / Full / NetTracker / UTIL / READUNIX.TXT < prev    next >
Encoding:
Text File  |  2001-10-17  |  13.5 KB  |  408 lines
  1. Welcome
  2. -------
  3.  
  4. Thank you for using NetTracker 3.5. We have tried to make NetTracker
  5. 3.5 as easy to use as possible. We have also tried to incorporate many
  6. powerful features into this version of NetTracker. However, we always
  7. welcome new ideas and suggestions to make NetTracker even easier to use
  8. and more powerful. Please e-mail your suggestions to feedback@sane.com.
  9. Please read this entire document before installing NetTracker.
  10.  
  11. Thank you.
  12.  
  13. The NetTracker Development Team
  14. Another Sane Solution
  15.  
  16. Installation
  17. ------------
  18.  
  19. To install NetTracker follow these simple steps:
  20.  
  21.     1. Unpack the archive into a temporary directory.
  22.    
  23.     2. Run the ntinstall program.
  24.  
  25.     3. Read and accept the license agreement.
  26.  
  27.     4. When prompted, enter your serial number.  You will find your
  28.        serial number located in the upper left hand corner of the inside
  29.        cover of the User's Guide.
  30.    
  31.     5. When prompted, enter your activation key.  You will find your
  32.        activation key in the upper left hand corner of the inside cover
  33.        of the User's Guide or in the email you received with download
  34.        instructions.
  35.        
  36.     6. When prompted, enter the program directory for NetTracker.  The
  37.        program directory will be used to store executable and database
  38.        files. Please make sure that you have plenty of disk space free on
  39.        this partition, as the amount of spaced used by NetTracker is
  40.        directly related to the number of hits your web server receives.
  41.    
  42.     7. When prompted, enter the HTML directory for NetTracker.  This
  43.        directory will be used to store the generated HTML reports, so it
  44.        must be under the document root for your web server.
  45.    
  46.     8. When prompted, enter the URL that corresponds to the HTML directory
  47.        that you specified in Step #7.
  48.    
  49.     9. When prompted, enter the CGI-BIN directory for NetTracker.  This 
  50.        directory will be used to store the CGI-BIN programs that allow you
  51.        to use NetTracker through your web browser, so it must be setup as a
  52.        CGI-BIN directory within your web server software.
  53.    
  54.     10. When prompted, enter the URL that corresponds to the CGI-BIN
  55.         directory that you specified in Step #9.
  56.     
  57.     11. Review your options and correct any mistakes.
  58.  
  59.     12. NetTracker will then finish the installation process and display a
  60.         URL for you to go to begin using NetTracker.
  61.  
  62. To configure NetTracker follow these simple steps:
  63.  
  64.  NetTracker Standard and Professional:
  65.  
  66.    1. Open your web browser and pull up the URL from Step 12 of the
  67.       install.
  68.  
  69.    2. Click on options in the top frame to configure NetTracker.
  70.  
  71.    3. Click on General in the left frame to setup your report options.  You
  72.       must set the "Name of organization:" and "URL of the site being
  73.       analyzed:" options. After you have entered appropriate values click
  74.       Save Options below.
  75.  
  76.    4. Click on "Log Files" in the left frame to tell NetTracker what log
  77.       files to process. Click Add to add another log file.  Select the log
  78.       file type on the left and enter the full path to the log file on the
  79.       right. Next, click Add.
  80.  
  81.    5. Other options are not required and can be left set to their defaults.
  82.  
  83.    6. To import your log data and generate a report now click the Update
  84.       button in the top frame.
  85.  
  86.    7. For additional configuration, see the user's manual or the on-line
  87.       help.
  88.  
  89.  NetTracker Enterprise and ISP:
  90.  
  91.    1. Open your web browser and pull up the URL from Step 12 of the
  92.       install.
  93.  
  94.    2. Click on the New Report button.
  95.  
  96.    3. Enter a short report name for your report and then click enter.  You
  97.       will then be presented with the options screen for the report you
  98.       are setting up.
  99.  
  100.    4. Click on General in the left frame to setup your report options.  You
  101.       must set the "Name of organization:" and "URL of the site being
  102.       analyzed:" options. After you have entered appropriate values click
  103.       Save Options below.
  104.  
  105.    5. Click on "Log Files" in the left frame to tell NetTracker what log
  106.       files to process. Click Add to add another log file.  Select the log
  107.       file type on the left and enter the full path to the log file on the
  108.       right. Next, click Add.
  109.  
  110.    6. Other options are not required and can be left set to their defaults.
  111.  
  112.    7. To import your log data and generate a report now click the View
  113.       Report button.  When the report is displayed click Update.
  114.  
  115.    8. For additional configuration, see the user's manual or the on-line
  116.       help.
  117.  
  118. Upgrading From NetTracker 3.0
  119. -----------------------------
  120. The following upgrade paths are possible:
  121.  
  122. NetTracker 3.0 -> NetTracker 3.5
  123. NetTracker 3.0 Professional -> NetTracker 3.5 Professional
  124. NetTracker 3.0 Enterprise -> NetTracker 3.5 Enterprise
  125.  
  126. To upgrade using one of the above upgrade paths:
  127.  
  128.    1. Make sure no NetTracker reports are currently running.
  129.  
  130.    2. Backup your current NetTracker installation.
  131.  
  132.    3. Unpack the archive into a temporary directory.
  133.  
  134.    4. Run the ntupgrade program.
  135.  
  136.    5. Read and accept the license agreement.
  137.  
  138.    6. When prompted enter your serial number and activation key.
  139.  
  140.    7. When the installation prompts you for the NetTracker program
  141.       directory enter your current NetTracker program directory.
  142.  
  143.    8. NetTracker will now update your current NetTracker installation.
  144.  
  145. Note:  When upgrading from NetTracker 3.0 to NetTracker 3.5 only
  146. configuration settings can be imported.  Any log data that has previously
  147. been imported will have to be reimported.
  148.  
  149. Upgrading between different versions of NetTracker 3.5
  150. ------------------------------------------------------
  151. The following upgrade paths are possible:
  152.  
  153. NetTracker 3.5 -> NetTracker 3.5 Professional
  154. NetTracker 3.5 -> NetTracker 3.5 Enterprise
  155. NetTracker 3.5 Professional -> NetTracker 3.5 Enterprise
  156.  
  157.   1. Make sure no NetTracker reports are currently running.
  158.   
  159.   2. Backup your current NetTracker installation.
  160.  
  161.   3. Unpack the archive into a temporary directory.
  162.  
  163.   4. Run the ntupgrade program.
  164.  
  165.   5. Read and accept the license agreement.
  166.  
  167.   6. When prompted enter your serial number and activation key.
  168.  
  169.   7. When the installation prompts you for the NetTracker program directory
  170.      enter your current NetTracker program directory.
  171.  
  172.   8. NetTracker will now update your current NetTracker installation.
  173.  
  174. Note:  When upgrading between different versions of NetTracker 3.5 only
  175. configuration settings and log data is imported.  After completing the
  176. upgrade process your NetTracker reports have to be regenerated.
  177.  
  178.  
  179. Browser Configuration
  180. ---------------------
  181.  
  182. It is recommended that you configure your web browser in the following way:
  183.  
  184. Netscape Navigator 3.X:
  185.  
  186.     1. Go to Network Preferences which is under the Options Menu
  187.  
  188.     2. Click on the cache tab.
  189.  
  190.     3. Set Verify Documents to every time.
  191.     
  192. Netscape Communicator 4.X:
  193.  
  194.     1. Go to Preferences, which is under the Edit menu.
  195.  
  196.     2. Double-Click on advanced under Category.
  197.  
  198.     3. Click on cache.
  199.  
  200.     4. On the right set "document is compared to document on network" to
  201.        "every time".
  202.     
  203. Microsoft Internet Explorer 3.X:
  204.  
  205.     1. Go to Options which is under the View Menu
  206.  
  207.     2. Click on the advanced tab.
  208.  
  209.     3. On the advanced page, under temporary internet files click the
  210.        settings button.
  211.  
  212.     4. Set "check for new versions of stored pages" to "every visit to
  213.        the page".
  214.  
  215.     5. Click OK
  216.  
  217. Microsoft Internet Explorer 4.X:
  218.  
  219.     1. Go to Internet Options which is under the View Menu
  220.  
  221.     2. Click on the general tab.
  222.  
  223.     3. Under temporary internet files click the settings button.
  224.  
  225.     4. Set "check for new versions of stored pages" to "every visit to the
  226.        page".
  227.  
  228.     5. Click OK
  229.  
  230.  
  231. Server Configuration
  232. --------------------
  233.  
  234. For optimal performance, it is recommended that you configure your web
  235. server in the following ways:
  236.  
  237. Host Name Resolution
  238.  
  239. We strongly recommend that you configure your web server to resolve host
  240. names instead of having NetTracker resolve them.  For more information on
  241. this, please consult your web server documentation.
  242.  
  243. Mime Types
  244.  
  245. NetTracker can export data, allowing users to import NetTracker reports
  246. into popular software products such as Microsoft Excel, Access and Word.
  247. NetTracker uses the .csv file extension when exporting data.  For optimal
  248. performance, it is recommended that you add the mime type
  249. "application/octet-stream" for the file extension ".csv".  For more
  250. information on this, please consult your web server documentation.
  251.  
  252. Report Automation
  253.  
  254. NetTracker comes with a command line utility, nettracker, which can be
  255. used to automatically generate reports each night.  The easiest way to
  256. configure this option is to add this command to your system's crontab file.
  257. For example, to update your reports each night at midnight, simply add:
  258.  
  259.   NetTracker Standard and Professional Editions:
  260.  
  261.     "0 0 * * * /path/to/program/directory/nettracker reports -quiet -dir
  262.     /path/to/program/directory/" to your system's crontab file.
  263.  
  264.   NetTracker Enterprise and ISP Editions:
  265.  
  266.     "0 0 * * * /path/to/program/directory/nettracker all -quiet -dir
  267.     /path/to/program/directory/" to your system's crontab file.
  268.  
  269. Password Protection
  270.  
  271. NetTracker does not come with any type of built in password protection to
  272. restrict access from unauthorized individuals.  Instead, we leave this task
  273. up to you to implement using your web server's built in password
  274. protection.
  275.  
  276. Command Line Options
  277. --------------------
  278.  
  279. NetTracker 3.5 and NetTracker 3.5 Professional:
  280.  
  281.   Usage: nettracker reports [options]
  282.  
  283.    -abort               Aborts the report
  284.    -clear               Clears the database
  285.    -debug               Instructs NetTracker to print debugging information
  286.    -dir <dir>           Specify the NetTracker program directory
  287.    -quiet               Instructs NetTracker not to print anything
  288.    -recalc              Recalculates the report databases from the imported data
  289.    -regen               Regenerates the HTML report files
  290.    -reindex             Reindexes the database
  291.  
  292. NetTracker 3.5 Enterprise:
  293.  
  294.   Usage: nettracker <short report name> [options]
  295.  
  296.    -abort               Aborts the report
  297.    -clear               Clears the database
  298.    -debug               Instructs NetTracker to print debugging information
  299.    -dir <dir>           Specify the NetTracker program directory
  300.    -quiet               Instructs NetTracker not to print anything
  301.    -recalc              Recalculates the report databases from the imported data
  302.    -regen               Regenerates the HTML report files
  303.    -reindex             Reindexes the database
  304.  
  305.    Note: <short report name> can be replaced with "all" to update all
  306.          reports, or "admin" to update only the server wide reports.
  307.  
  308. Server Specific Notes
  309. ---------------------
  310.  
  311. Apache
  312.  
  313. In order to get Apache to log into NCSA Combined Log Format, you must first
  314. enable the configurable log format.  You will need to edit the
  315. "Configuration" file in your source code directory, make sure that
  316. common_log_module, agent_log_module, and referer_log_module are commented
  317. out, and that config_log_module is enabled.  After you recompile Apache you
  318. will need to make the following changes to your httpd.conf file: 
  319.   
  320. 1. Remove any RefererLog directives.
  321. 2. Remove any AgentLog directives.
  322. 3. Add the following LogFormat directive:
  323.  
  324. LogFormat "%h %l %u %t \"%r\" %s %b \"%{Referer}i\" \"%{User-agent}i\""
  325.  
  326. Now you should shut down your server, rotate your old logs, install the new
  327. binary and start Apache back up.
  328.  
  329. For the NetTracker export function to work properly it is necessary to edit
  330. the server mime.types file. The following steps are necessary to
  331. accomplish this:
  332.  
  333. 1. Change to the directory in which you installed Apache.
  334.  
  335. 2. Open the file mime.types with a text editor.
  336.  
  337. 3. Look for the line: 
  338.    application/octet-stream      bin
  339.  
  340. 4. Change it to read:
  341.    application/octet-stream      bin csv
  342.  
  343. 5. Restart Apache.
  344.  
  345.  
  346. Netscape FastTrack/Enterprise
  347.  
  348. For the NetTracker export function to work properly it is necessary to edit the
  349. server mime.types file. The following steps are necessary to accomplish
  350. this:
  351.  
  352. 1. Change to the directory in which the configuration files are located for
  353.    the server on which you installed NetTracker. 
  354.  
  355. 2. Open the file mime.types with a text editor.
  356.  
  357. 3. Look for the line: 
  358.         type=application/octet-stream  ext=bin
  359.  
  360. 4. Change it to read: 
  361.         type=application/octet-stream  ext=bin,csv
  362.  
  363. 5. Restart the Server.
  364.  
  365. Logging with Netscape servers:
  366.  
  367. With Netscape servers we recommend that you log to Netscape Flexible Log
  368. Format and turn on the following options:
  369.  
  370.     Log client accesses?
  371.         Yes
  372.     Record:
  373.         Domain Names
  374.     Format:
  375.         Only log: (Turn on the following fields)
  376.             ╖ Client hostname
  377.             ╖ Authenticate user name
  378.             ╖ System date
  379.             ╖ Full request
  380.             ╖ Status
  381.             ╖ Content length
  382.             ╖ HTTP header, "referer"
  383.             ╖ HTTP header, "user-agent"
  384.  
  385. Note:
  386.  
  387. On both FastTrack and Enterprise servers CGI is NOT setup by default.  If
  388. you have not already done so it will be necessary to setup a cgi-bin
  389. directory.
  390.  
  391.  
  392. Lotus Notes 4.6+
  393.  
  394. By default logging is turned off in Notes.  You will need to turn on
  395. logging in your http server configuration.  Under "Enable Logging To:",
  396. select  enabled to the right of "Log Files:"
  397.  
  398. Lotus Notes logs agent and referrer information to separate files from the
  399. main log file.  For NetTracker to correctly analyze these logs they must
  400. all be in the same directory and only the access log should be specified
  401. in the NetTracker options.   NetTracker also requires that the agent and
  402. referrer logs follow the Lotus Notes naming convention.
  403.  
  404. Since the logging is separated into 3 files, be sure to rotate all three
  405. files at the same time.
  406.  
  407.  
  408.